home *** CD-ROM | disk | FTP | other *** search
/ Revista do CD-ROM 98 / CD-ROM 98.iso / infantil / tuxmath / tuxmath-2001.09.07-win32-installer.exe / docs / INSTALL.txt < prev    next >
Encoding:
Text File  |  2001-09-06  |  6.3 KB  |  195 lines
  1. INSTALL.txt for "tuxmath"
  2.  
  3. September 6, 2001
  4.  
  5.  
  6. [ NOTE: When (and if) TuxMath changes from a simple Makefile system to
  7.   an autoconf/automake system, parts of this document will need to change! ]
  8.  
  9.  
  10. Requirements
  11. ------------
  12.   Operating System
  13.   ----------------
  14.     "Tux, of Math Command" ("TuxMath" for short) requires a computer and
  15.     operating system supported by libSDL.  At the time this document was
  16.     written, this included:
  17.  
  18.       Windows 32-bit
  19.       MacOS
  20.       Linux
  21.       Solaris
  22.       IRIX
  23.       FreeBSD
  24.       BeOS
  25.  
  26.  
  27.   CPU
  28.   ---
  29.     [ Minimum requirements should be P90, but not sure yet... ]
  30.     [ Architectures including i386, Alpha, PPC, Sparc64, 68000<?> ]
  31.  
  32.  
  33.   Video Display
  34.   -------------
  35.     TuxMath displays the game screen in a 640x480 window.
  36.  
  37.     If supported by your system, the game can also display in full-screen
  38.     mode (see "README.txt" or the program's "--usage" display).
  39.  
  40.     When attempting to run in fullscreen mode on systems where true 640x480
  41.     resolution isn't available for some reason, the next-lowest resolution
  42.     available will be used, and the game area will be centered within a
  43.     black screen.
  44.  
  45.     TuxMath prefers 16bpp (bits per pixel) color depth, but can run in
  46.     8bpp (256 colors) if that's all that is available.
  47.  
  48.  
  49.   Sound Card
  50.   ----------
  51.     TuxMath attempts to play stereo 16-bit sound and music at
  52.     44.1Khz, if possible.
  53.  
  54.     Sound, however, is optional, and can be disabled at compile-time
  55.     (see below) or run-time (see "README.txt" or the program's "--usage"
  56.     display).
  57.  
  58.  
  59.   Input Methods
  60.   -------------
  61.     The game is typically played using a keyboard.  The numeric keypad
  62.     portion of standard PC keyboards is supported (so if there are any
  63.     stand-alone numeric keyboards with no other keys, they SHOULD work, too).
  64.  
  65.     Menus and options can be controlled with either the pointer or the
  66.     keyboard's arrow keys.
  67.  
  68.     The game can also be played with a large, on-screen numeric keypad
  69.     which can be accessed using the pointer (ie, a mouse, trackball,
  70.     touch-screen monitor, touchpad, etc.).  (See "README.txt" or the
  71.     game's "--usage" display).
  72.  
  73.  
  74.   Required Libraries
  75.   ------------------
  76.     "Tux, of Math Command" uses the Simple DirectMedia Layer library (libSDL)
  77.     to display graphics, receive keyboard and mouse input, and play sounds.
  78.     (It was designed around libSDL version 1.2, but later versions should
  79.     work.)
  80.  
  81.     It uses the SDL helper library "SDL_image" to load the game's graphics
  82.     data, as they are in PNG (Portable Network Graphic) format.
  83.  
  84.     Also, by default, it uses "SDL_mixer" to load and play the game's
  85.     sound and music.  This library is optional, but without it, the program
  86.     will be completely silent.
  87.  
  88.     Note: libSDL, SDL_image and SDL_mixer are all free, Open Source libraries,
  89.     released under the GNU Library General Public License (LGPL).
  90.  
  91.     Getting SDL
  92.     -----------
  93.       You can download "libSDL," "SDL_image," and "SDL_mixer" from the
  94.       SDL website:
  95.  
  96.       http://www.libsdl.org/
  97.  
  98.  
  99.       Specifically, the download pages for each are here:
  100.  
  101.         libSDL:     http://www.libsdl.org/download-1.2.html
  102.         SDL_image:  http://www.libsdl.org/projects/SDL_image/
  103.         SDL_mixer:  http://www.libsdl.org/projects/SDL_mixer/
  104.  
  105.       Using SDL Packages
  106.       ------------------
  107.         When building "TuxMath" from source, if you decide to install the
  108.         SDL libraries using packages (RedHat RPMs or DEBs), you'll
  109.         need to install not only each library's 'binary' package, but ALSO
  110.         each library's 'development' package.
  111.  
  112.         These contain the text "-devel" in the package name.
  113.  
  114.         Also note: Make sure you download the packages for the appropriate
  115.         operating system and architecture (eg, an RPM for Linux/i386 for
  116.         RedHat Linux on Intel-compatible computers).
  117.  
  118.  
  119.  
  120. Compiling and Installing TuxMath
  121. --------------------------------
  122.   Linux/Unix
  123.   ----------
  124.     Compiling the Program
  125.     ---------------------
  126.       To compile the "tuxmath" binary, simply issue the following command:
  127.  
  128.         make
  129.  
  130.       This will compile the source files and, unless any errors occur,
  131.       create a "tuxmath" executable program in the TuxMath directory.
  132.  
  133.  
  134.       If you wish to build the program without sound support (in this
  135.       case, the "SDL_mixer" does NOT need to be installed), run this
  136.       command instead:
  137.  
  138.         make nosound
  139.  
  140.  
  141.       NOTE: See below to change the installation directory for TuxMath.
  142.  
  143.  
  144.     Installing
  145.     ----------
  146.       Once compiled, you can have the program and graphics/sound data
  147.       files copied to a shared location on your system.
  148.  
  149.       First, change to the superuser (root), by running the "su"
  150.       command and entering root's password.  Then, run this command:
  151.  
  152.         make install
  153.  
  154.       By default, the program will be copied into "/usr/local/bin/"
  155.       and the data will be copied into a new directory,
  156.       "/usr/share/tuxmath/".
  157.  
  158.  
  159.     Changing Installation Directory
  160.     -------------------------------
  161.       If you wish to override the default installation directories
  162.       for TuxMath, you can specify them when you run "make"
  163.       (or "make nosound").  Do this BEFORE running "make install".
  164.  
  165.         make DATA_PREFIX=/path/to/put/data/ BIN_PREFIX=/path/for/executable/
  166.  
  167.  
  168.       For example, if you do not have superuser access on the computer
  169.       you're installing in, and wish to simply run TuxMath from within
  170.       your home directory, you can run:
  171.  
  172.         make DATA_PREFIX=/home/usernmame/tuxmath-data/   \
  173.              BIN_PREFIX=/home/username/bin/
  174.  
  175.       And when you go to install, run "make install" with the same:
  176.  
  177.         make install DATA_PREFIX=/home/usernmame/tuxmath-data/   \
  178.                      BIN_PREFIX=/home/username/bin/
  179.  
  180.       The data files will be copied into "tuxmath-data" in your home
  181.       directory, and the program will be copied into the "bin" directory.
  182.  
  183.  
  184.     Cleaning Up
  185.     -----------
  186.       If you need to re-make from scratch for some reason (for example,
  187.       you wish to change the "DATA_PREFIX" value when you run "make"),
  188.       you can have all of the compiled files (the program, and all of the
  189.       object files in the "obj/" directory) deleted by running:
  190.  
  191.         make clean
  192.  
  193.  
  194. [ UNDER CONSTRUCTION ]
  195.